<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class SecurityConstraint</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class SecurityConstraint</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">SecurityConstraint class</p>
<p class="description"><p>Representation of a security constraint element for a web application,  as represented in a <div class="src-code"><ol><li><div class="src-line"><span class="src-sym">&amp;</span><span class="src-id">lt</span><span class="src-sym">;</span><span class="src-id">security</span>-<span class="src-id">constraint</span><span class="src-sym">&amp;</span><span class="src-id">gt</span><span class="src-sym">;</span></div></li>
</ol></div> element in the  deployment descriptor.  &lt;p&gt;
 <strong>WARNING</strong>:  It is assumed that instances of this class will be created  and modified only within the context of a single thread, before the instance  is made visible to the remainder of the application.  After that, only read  access is expected.  Therefore, none of the read and write access within  this class is synchronized.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeroen Simons &lt;<a href="mailto:jeroen@melange.nl">jeroen@melange.nl</a>&gt;</li>
				<li><span class="field">copyright:</span> Copyright (c) 2007 Jeroen Simons. All rights reserved</li>
				<li><span class="field">link:</span> <a href="http://www.melange.nl/">http://www.melange.nl/</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_aas---deploy---Deploy.php.html">/aas/deploy/Deploy.php</a> (line <span class="field">568</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																				
												<div class="method-definition">
											<span class="method-result">SecurityConstraint</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addAuthRole" title="details" class="method-name">addAuthRole</a>
											(<span class="var-type">authRole</span>&nbsp;<span class="var-name">$authRole</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addCollection" title="details" class="method-name">addCollection</a>
											(<span class="var-type"><a href="../aas/SecurityCollection.html">SecurityCollection</a></span>&nbsp;<span class="var-name">$collection</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findAuthRole" title="details" class="method-name">findAuthRole</a>
											(<span class="var-type">role</span>&nbsp;<span class="var-name">$role</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findAuthRoles" title="details" class="method-name">findAuthRoles</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findCollection" title="details" class="method-name">findCollection</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findCollections" title="details" class="method-name">findCollections</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getAllRoles" title="details" class="method-name">getAllRoles</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getAuthConstraint" title="details" class="method-name">getAuthConstraint</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getUserConstraint" title="details" class="method-name">getUserConstraint</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#included" title="details" class="method-name">included</a>
											(<span class="var-type">uri</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type">method</span>&nbsp;<span class="var-name">$method</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeAuthRole" title="details" class="method-name">removeAuthRole</a>
											(<span class="var-type">authRole</span>&nbsp;<span class="var-name">$authRole</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeCollection" title="details" class="method-name">removeCollection</a>
											(<span class="var-type"><a href="../aas/SecurityCollection.html">SecurityCollection</a></span>&nbsp;<span class="var-name">$collection</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setAuthConstraint" title="details" class="method-name">setAuthConstraint</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$authConstraint</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setUserConstraint" title="details" class="method-name">setUserConstraint</a>
											(<span class="var-type">userConstraint</span>&nbsp;<span class="var-name">$userConstraint</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">577</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Construct a new security constraint instance with default values.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">SecurityConstraint</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodaddAuthRole" id="addAuthRole"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">addAuthRole</span> (line <span class="line-number">690</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add an authorization role, which is a role name that will be  permitted access to the resources protected by this security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addAuthRole
		</span>
					(<span class="var-type">authRole</span>&nbsp;<span class="var-name">$authRole</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">authRole</span>
				<span class="var-name">$authRole</span><span class="var-description">: Role name to be added</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddCollection" id="addCollection"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">addCollection</span> (line <span class="line-number">709</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a new web resource collection to those protected by this  security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addCollection
		</span>
					(<span class="var-type"><a href="../aas/SecurityCollection.html">SecurityCollection</a></span>&nbsp;<span class="var-name">$collection</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">collection</span>
				<span class="var-name">$collection</span><span class="var-description">: The new web resource collection</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfindAuthRole" id="findAuthRole"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">findAuthRole</span> (line <span class="line-number">725</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if the specified role is permitted access to  the resources protected by this security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findAuthRole
		</span>
					(<span class="var-type">role</span>&nbsp;<span class="var-name">$role</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">role</span>
				<span class="var-name">$role</span><span class="var-description">: Role name to be checked</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfindAuthRoles" id="findAuthRoles"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">findAuthRoles</span> (line <span class="line-number">738</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the set of roles that are permitted access to the resources  protected by this security constraint.  If none have been defined,  a zero-length array is returned (which implies that all authenticated  users are permitted access).</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findAuthRoles
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodfindCollection" id="findCollection"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">findCollection</span> (line <span class="line-number">749</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the web resource collection for the specified name, if any;  otherwise, return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findCollection
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Web resource collection name to return</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfindCollections" id="findCollections"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">findCollections</span> (line <span class="line-number">766</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return all of the web resource collections protected by this  security constraint.  If there are none, a zero-length array is  returned.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findCollections
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetAllRoles" id="getAllRoles"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getAllRoles</span> (line <span class="line-number">629</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Was the &quot;all roles&quot; wildcard included in this authentication</p>
<p class="description"><p>constraint?</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getAllRoles
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetAuthConstraint" id="getAuthConstraint"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAuthConstraint</span> (line <span class="line-number">640</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the authorization constraint present flag for this security  constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getAuthConstraint
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetUserConstraint" id="getUserConstraint"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getUserConstraint</span> (line <span class="line-number">661</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the user data constraint for this security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getUserConstraint
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodincluded" id="included"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">included</span> (line <span class="line-number">780</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if the specified context-relative URI (and  associated HTTP method) are protected by this security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			included
		</span>
					(<span class="var-type">uri</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type">method</span>&nbsp;<span class="var-name">$method</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">uri</span>
				<span class="var-name">$uri</span><span class="var-description">: Context-relative URI to check</span>			</li>
					<li>
				<span class="var-type">method</span>
				<span class="var-name">$method</span><span class="var-description">: Request method being used</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveAuthRole" id="removeAuthRole"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removeAuthRole</span> (line <span class="line-number">809</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove the specified role from the set of roles permitted to access  the resources protected by this security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeAuthRole
		</span>
					(<span class="var-type">authRole</span>&nbsp;<span class="var-name">$authRole</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">authRole</span>
				<span class="var-name">$authRole</span><span class="var-description">: Role name to be removed</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveCollection" id="removeCollection"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">removeCollection</span> (line <span class="line-number">830</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove the specified web resource collection from those protected by  this security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeCollection
		</span>
					(<span class="var-type"><a href="../aas/SecurityCollection.html">SecurityCollection</a></span>&nbsp;<span class="var-name">$collection</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">collection</span>
				<span class="var-name">$collection</span><span class="var-description">: Web resource collection to be removed</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetAuthConstraint" id="setAuthConstraint"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setAuthConstraint</span> (line <span class="line-number">651</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the authorization constraint present flag for this security  constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setAuthConstraint
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$authConstraint</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$authConstraint</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetUserConstraint" id="setUserConstraint"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setUserConstraint</span> (line <span class="line-number">673</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the user data constraint for this security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setUserConstraint
		</span>
					(<span class="var-type">userConstraint</span>&nbsp;<span class="var-name">$userConstraint</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">userConstraint</span>
				<span class="var-name">$userConstraint</span><span class="var-description">: The new user data constraint</span>			</li>
				</ul>
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">848</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return a String representation of this security constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 10 Feb 2008 15:16:15 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>